home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / MrmOpenHierarchyPerDisplay.z / MrmOpenHierarchyPerDisplay
Encoding:
Text File  |  2002-10-03  |  18.2 KB  |  265 lines

  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy - Allocates a hierarchy ID and
  10.           opens all the UID files in the hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<MMMMrrrrmmmm////MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh>>>>
  14.  
  15.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy ((((_d_i_s_p_l_a_y, _n_u_m__f_i_l_e_s, _f_i_l_e__n_a_m_e_s__l_i_s_t,
  16.           _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t, _h_i_e_r_a_r_c_h_y__i_d))))
  17.                DDDDiiiissssppppllllaaaayyyy          ****_d_i_s_p_l_a_y;;;;
  18.                MMMMrrrrmmmmCCCCoooouuuunnnntttt         _n_u_m__f_i_l_e_s;;;;
  19.                SSSSttttrrrriiiinnnngggg           _f_i_l_e__n_a_m_e_s__l_i_s_t[[[[]]]];;;;
  20.                MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr****_a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t;;;;
  21.                MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy     ****_h_i_e_r_a_r_c_h_y__i_d;;;;
  22.  
  23.  
  24.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  25.           This page documents version 1.2 of the Motif library.
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy allows you to specify the list of
  29.           UID files that MRM searches in subsequent fetch operations.
  30.           All subsequent fetch operations return the first occurrence
  31.           of the named item encountered while traversing the UID
  32.           hierarchy from the first list element (UID file
  33.           specification) to the last list element.  This function also
  34.           allocates a hierarchy ID and opens all the UID files in the
  35.           hierarchy.  It initializes the optimized search lists in the
  36.           hierarchy.  If MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy encounters any
  37.           errors during its execution, any files that were opened are
  38.           closed.
  39.  
  40.           The application must call XXXXttttAAAAppppppppIIIInnnniiiittttiiiiaaaalllliiiizzzzeeee before calling
  41.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  42.  
  43.  
  44.           _d_i_s_p_l_a_y          Specifies the connection to the X server
  45.                            and the value to pass to XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee.
  46.                            For more information on the Display
  47.                            structure, see the Xlib function
  48.                            XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy.
  49.  
  50.           _n_u_m__f_i_l_e_s        Specifies the number of files in the name
  51.                            list.
  52.  
  53.           _f_i_l_e__n_a_m_e_s__l_i_s_t  Specifies an array of character strings
  54.                            that identify the UID files.
  55.  
  56.           _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t
  57.                            A list of operating-system-dependent
  58.                            ancillary structures corresponding to such
  59.                            things as filenames, clobber flag, and so
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                            forth.  This argument should be NULL for
  75.                            most operations.  If you need to reference
  76.                            this structure, see the definition of
  77.                            MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr in MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh for more
  78.                            information.
  79.  
  80.           _h_i_e_r_a_r_c_h_y__i_d     Returns the search hierarchy ID.  The
  81.                            search hierarchy ID identifies the list of
  82.                            UID files that MRM searches (in order) when
  83.                            performing subsequent fetch calls.
  84.  
  85.  
  86.           Each UID file string in _f_i_l_e__n_a_m_e_s__l_i_s_t can specify either a
  87.           full pathname or a filename.  If a UID file string has a
  88.           leading slash (/), it specifies a full pathname, and MRM
  89.           opens the file as specified.  Otherwise, the UID file string
  90.           specifies a filename.  In this case MRM looks for the file
  91.           along a search path specified by the UUUUIIIIDDDDPPPPAAAATTTTHHHH environment
  92.           variable or by a default search path, which varies depending
  93.           on whether or not the XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR environment variable is
  94.           set.
  95.  
  96.           The UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable specifies a search path and
  97.           naming conventions associated with UID files.  It can
  98.           contain the substitution field %U, where the UID file string
  99.           from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to
  100.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy is substituted for %U.  It can
  101.           also contain the substitution fields accepted by
  102.           XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee.  The substitution field %T is always
  103.           mapped to uuuuiiiidddd.  The entire path is first searched with %S
  104.           mapped to ....uuuuiiiidddd and then, if no file is found, is searched
  105.           again with %S mapped to NULL.  For example, the following
  106.           UUUUIIIIDDDDPPPPAAAATTTTHHHH value and MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy call cause MRM
  107.           to open two separate UID files:
  108.  
  109.           UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L
  110.             static char *uid_files[] = {"/usr/users/me/test.uid", "test2"};
  111.             MrmHierarchy  *Hierarchy_id;
  112.             MrmOpenHierarchyPerDisplay((MrmCount)2,uid_files, NULL, Hierarchy_id)
  113.  
  114.  
  115.           MRM opens the first file, ////uuuussssrrrr////uuuusssseeeerrrrssss////mmmmeeee////tttteeeesssstttt....uuuuiiiidddd, as
  116.           specified in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to
  117.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy, because the UID file string in
  118.           the _f_i_l_e__n_a_m_e_s__l_i_s_t argument specifies a full pathname.  MRM
  119.           looks for the second file, tttteeeesssstttt2222, first as
  120.           ////uuuuiiiiddddlllliiiibbbb////%%%%LLLL////tttteeeesssstttt2222....uuuuiiiidddd and second as ////uuuuiiiiddddlllliiiibbbb////tttteeeesssstttt2222////%%%%LLLL, where
  121.           the display's language string is substituted for %L.
  122.  
  123.           After MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy opens the UID hierarchy,
  124.           you should not delete or modify the UID files until you
  125.           close the UID hierarchy by calling MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           If UUUUIIIIDDDDPPPPAAAATTTTHHHH is not set but the environment variable
  141.           XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames:
  142.  
  143.                     %%%%UUUU%%%%SSSS
  144.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  145.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  146.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  147.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  148.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  149.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  150.                     $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  151.                     $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS
  152.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  153.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  154.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  155.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  156.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  157.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  158.                     ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  159.  
  160.  
  161.           If neither UUUUIIIIDDDDPPPPAAAATTTTHHHH nor XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the
  162.           following pathnames:
  163.  
  164.                     %%%%UUUU%%%%SSSS
  165.                     $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  166.                     $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  167.                     $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  168.                     $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  169.                     $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  170.                     $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  171.                     $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS
  172.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  173.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  174.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS
  175.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  176.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  177.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  178.                     ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS
  179.  
  180.  
  181.           These paths are defaults that vendors may change.  For
  182.           example, a vendor may use different directories for
  183.           ////uuuussssrrrr////lllliiiibbbb////XXXX11111111 and ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111.
  184.  
  185.           The following substitutions are used in these paths:
  186.  
  187.  
  188.           %%%%UUUU   The UID file string, from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument.
  189.  
  190.           %%%%NNNN   The class name of the application.
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           %%%%LLLL   The display's language string.
  207.  
  208.           %%%%llll   The language component of the display's language
  209.                string.
  210.  
  211.           %%%%SSSS   The suffix to the file name.  The entire path is
  212.                searched first with a suffix of ....uuuuiiiillll, and if no file is
  213.                found, it is searched again with a NULL suffix.
  214.  
  215.  
  216.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  217.           This function returns one of these status return constants:
  218.  
  219.  
  220.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS          The function executed successfully.
  221.  
  222.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD        File not found.
  223.  
  224.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE          The function failed.
  225.  
  226.  
  227.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  228.           MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))).
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.